<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftsocketclient;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.IOException;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.net.Socket;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.net.SocketException;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.HashMap;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.LinkedList;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.Map;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import org.apache.log4j.Logger;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    /**<a name="line.12"></a>
<FONT color="green">013</FONT>     * A low level message client that mediates messages from and to a server and the client in the form of 'datagrams' (custom serialized<a name="line.13"></a>
<FONT color="green">014</FONT>     * messages identified by a unique signature). See {@link ServerMessageToClient} for further details on these messages.<a name="line.14"></a>
<FONT color="green">015</FONT>     * &lt;p&gt;<a name="line.15"></a>
<FONT color="green">016</FONT>     * This class manages some client basics such as the client {@link Socket}, {@link ClientType} to create the client endpoint with, the host<a name="line.16"></a>
<FONT color="green">017</FONT>     * and port on which this server listens and the client state (stopped, stopping, running). This class also contains the lists of message<a name="line.17"></a>
<FONT color="green">018</FONT>     * types mapped to the unique identifiers known to both the client and server.<a name="line.18"></a>
<FONT color="green">019</FONT>     * &lt;p&gt;<a name="line.19"></a>
<FONT color="green">020</FONT>     * Furthermore, this class receives a new server connection and assigns a {@link ServerHandler} instance (see {@link #serverHandler}). The<a name="line.20"></a>
<FONT color="green">021</FONT>     * server handler offers executable messages from the server back for the client to queue them and execute them sequentially (see<a name="line.21"></a>
<FONT color="green">022</FONT>     * {@link #serverMessages}).<a name="line.22"></a>
<FONT color="green">023</FONT>     * &lt;p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     * This server embodies the server listening function regardless of the type of client (UDP / TCP) in a uniform way. The differences between<a name="line.24"></a>
<FONT color="green">025</FONT>     * UDP and TCP are managed by the {@link #clientType}. Everything that this client is used for can be done with either TCP or UDP without<a name="line.25"></a>
<FONT color="green">026</FONT>     * the user having to change anything. Just provide the right {@link ClientType} and the client changes without breaking API.<a name="line.26"></a>
<FONT color="green">027</FONT>     * <a name="line.27"></a>
<FONT color="green">028</FONT>     * @author Benny Bottema<a name="line.28"></a>
<FONT color="green">029</FONT>     * @since 1.0<a name="line.29"></a>
<FONT color="green">030</FONT>     */<a name="line.30"></a>
<FONT color="green">031</FONT>    public class SwiftSocketClient {<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>            private static final Logger LOGGER = Logger.getLogger(SwiftSocketClient.class);<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>            /**<a name="line.35"></a>
<FONT color="green">036</FONT>             * The internal message id, {@value #MESSAGE_ID_PINGPONG}, used to communicate ping pong messages.<a name="line.36"></a>
<FONT color="green">037</FONT>             */<a name="line.37"></a>
<FONT color="green">038</FONT>            private static final int MESSAGE_ID_PINGPONG = 999;<a name="line.38"></a>
<FONT color="green">039</FONT>            /**<a name="line.39"></a>
<FONT color="green">040</FONT>             * The internal message id, {@value #MESSAGE_ID_BYEBYE}, used to send a Bye Bye notification.<a name="line.40"></a>
<FONT color="green">041</FONT>             */<a name="line.41"></a>
<FONT color="green">042</FONT>            private static final int MESSAGE_ID_BYEBYE = 998;<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>            private final String host;<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>            private final int port;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>            private final ClientType clientType;<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>            private ClientEndpoint clientEndpoint;<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>            /**<a name="line.52"></a>
<FONT color="green">053</FONT>             * Used to identify a {@link ServerMessageToClient} type that can handle a binary packet.<a name="line.53"></a>
<FONT color="green">054</FONT>             */<a name="line.54"></a>
<FONT color="green">055</FONT>            private final Map&lt;Integer, Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt;&gt; serverMessageToClientTypeList;<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>            /**<a name="line.57"></a>
<FONT color="green">058</FONT>             * Contains context objects mapped directly against a executable client message type. Usage of this list is optional.<a name="line.58"></a>
<FONT color="green">059</FONT>             * &lt;p&gt;<a name="line.59"></a>
<FONT color="green">060</FONT>             * This mechanism automates executing messages using a pre-registered context object. Client messages that are registered in this list<a name="line.60"></a>
<FONT color="green">061</FONT>             * will not be queued in the {@link #serverMessages} queue for manual processing.<a name="line.61"></a>
<FONT color="green">062</FONT>             */<a name="line.62"></a>
<FONT color="green">063</FONT>            private final Map&lt;Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt;, Object&gt; executionContexts;<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>            /**<a name="line.65"></a>
<FONT color="green">066</FONT>             * Used to prepend the right binary packet code for a given {@link ClientMessageToServer} type.<a name="line.66"></a>
<FONT color="green">067</FONT>             */<a name="line.67"></a>
<FONT color="green">068</FONT>            private final Map&lt;Class&lt;? extends ClientMessageToServer&gt;, Integer&gt; clientMessageToServerIdList;<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>            /**<a name="line.70"></a>
<FONT color="green">071</FONT>             * A queue that contains unprocessed messages from the server.<a name="line.71"></a>
<FONT color="green">072</FONT>             */<a name="line.72"></a>
<FONT color="green">073</FONT>            private final LinkedList&lt;ServerMessageToClient&lt;?&gt;&gt; serverMessages;<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>            /**<a name="line.75"></a>
<FONT color="green">076</FONT>             * A server connection handler, for receiving {@link ServerMessageToClient} messages and sending {@link ClientMessageToServer} messages.<a name="line.76"></a>
<FONT color="green">077</FONT>             */<a name="line.77"></a>
<FONT color="green">078</FONT>            private ServerHandler serverHandler;<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>            private boolean stopping;<a name="line.80"></a>
<FONT color="green">081</FONT>    <a name="line.81"></a>
<FONT color="green">082</FONT>            /**<a name="line.82"></a>
<FONT color="green">083</FONT>             * Default constructor, calls {@link #SwiftSocketClient(String, int, ClientType)} with TCP {@link ClientType}.<a name="line.83"></a>
<FONT color="green">084</FONT>             * <a name="line.84"></a>
<FONT color="green">085</FONT>             * @param host The host address on which to start listening.<a name="line.85"></a>
<FONT color="green">086</FONT>             * @param port The port on which to start listening.<a name="line.86"></a>
<FONT color="green">087</FONT>             */<a name="line.87"></a>
<FONT color="green">088</FONT>            public SwiftSocketClient(final String host, final int port) {<a name="line.88"></a>
<FONT color="green">089</FONT>                    this(host, port, ClientType.TCP);<a name="line.89"></a>
<FONT color="green">090</FONT>            }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>            /**<a name="line.92"></a>
<FONT color="green">093</FONT>             * Creates a swift socket client and registers a couple of basic message types (message invalid, pingpong and byebye).<a name="line.93"></a>
<FONT color="green">094</FONT>             * &lt;ul&gt;<a name="line.94"></a>
<FONT color="green">095</FONT>             * &lt;li&gt;Message invalid: sent to the server when a message code was not recognized&lt;/li&gt;<a name="line.95"></a>
<FONT color="green">096</FONT>             * &lt;li&gt;Pong message: sent when a Ping message was received from the server&lt;/li&gt;<a name="line.96"></a>
<FONT color="green">097</FONT>             * &lt;li&gt;ByeBye message: sent to signal the server the client has been closed (gracefully disconnecting instead of just dropping the<a name="line.97"></a>
<FONT color="green">098</FONT>             * connection)&lt;/li&gt;<a name="line.98"></a>
<FONT color="green">099</FONT>             * &lt;/ul&gt;<a name="line.99"></a>
<FONT color="green">100</FONT>             * <a name="line.100"></a>
<FONT color="green">101</FONT>             * @param host The host address on which to start listening.<a name="line.101"></a>
<FONT color="green">102</FONT>             * @param port The port on which to start listening.<a name="line.102"></a>
<FONT color="green">103</FONT>             * @param clientType The {@link ClientType} strategy used to communicate.<a name="line.103"></a>
<FONT color="green">104</FONT>             */<a name="line.104"></a>
<FONT color="green">105</FONT>            public SwiftSocketClient(final String host, final int port, final ClientType clientType) {<a name="line.105"></a>
<FONT color="green">106</FONT>                    this.host = host;<a name="line.106"></a>
<FONT color="green">107</FONT>                    this.port = port;<a name="line.107"></a>
<FONT color="green">108</FONT>                    this.clientType = clientType;<a name="line.108"></a>
<FONT color="green">109</FONT>    <a name="line.109"></a>
<FONT color="green">110</FONT>                    serverMessageToClientTypeList = new HashMap&lt;Integer, Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt;&gt;();<a name="line.110"></a>
<FONT color="green">111</FONT>                    clientMessageToServerIdList = new HashMap&lt;Class&lt;? extends ClientMessageToServer&gt;, Integer&gt;();<a name="line.111"></a>
<FONT color="green">112</FONT>                    serverMessages = new LinkedList&lt;ServerMessageToClient&lt;?&gt;&gt;();<a name="line.112"></a>
<FONT color="green">113</FONT>                    executionContexts = new HashMap&lt;Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt;, Object&gt;();<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>                    registerClientMessageToServerType(MESSAGE_ID_PINGPONG, ClientMessageToServerPingPong.class);<a name="line.115"></a>
<FONT color="green">116</FONT>                    registerClientMessageToServerType(MESSAGE_ID_BYEBYE, ClientMessageToServerByeBye.class);<a name="line.116"></a>
<FONT color="green">117</FONT>    <a name="line.117"></a>
<FONT color="green">118</FONT>                    registerServerMessageToClientType(MESSAGE_ID_PINGPONG, ServerMessageToClientPingPong.class);<a name="line.118"></a>
<FONT color="green">119</FONT>            }<a name="line.119"></a>
<FONT color="green">120</FONT>    <a name="line.120"></a>
<FONT color="green">121</FONT>            /**<a name="line.121"></a>
<FONT color="green">122</FONT>             * Registers a client-to-server message on the given unique identifier. Both the client and server must use the same identifier to be<a name="line.122"></a>
<FONT color="green">123</FONT>             * able to decode the message on the server.<a name="line.123"></a>
<FONT color="green">124</FONT>             * <a name="line.124"></a>
<FONT color="green">125</FONT>             * @param messageId The unique identifier for this message type.<a name="line.125"></a>
<FONT color="green">126</FONT>             * @param messageType A {@link ClientMessageToServer} sub type.<a name="line.126"></a>
<FONT color="green">127</FONT>             */<a name="line.127"></a>
<FONT color="green">128</FONT>            public void registerClientMessageToServerType(final int messageId, final Class&lt;? extends ClientMessageToServer&gt; messageType) {<a name="line.128"></a>
<FONT color="green">129</FONT>                    clientMessageToServerIdList.put(messageType, messageId);<a name="line.129"></a>
<FONT color="green">130</FONT>            }<a name="line.130"></a>
<FONT color="green">131</FONT>    <a name="line.131"></a>
<FONT color="green">132</FONT>            /**<a name="line.132"></a>
<FONT color="green">133</FONT>             * Registers a server-to-client message on the given unique identifier. Both the client and server must use the same identifier to be<a name="line.133"></a>
<FONT color="green">134</FONT>             * able to decode the message on the client.<a name="line.134"></a>
<FONT color="green">135</FONT>             * <a name="line.135"></a>
<FONT color="green">136</FONT>             * @param messageId The unique identifier for this message type.<a name="line.136"></a>
<FONT color="green">137</FONT>             * @param messageType A {@link ServerMessageToClient} sub type.<a name="line.137"></a>
<FONT color="green">138</FONT>             */<a name="line.138"></a>
<FONT color="green">139</FONT>            public void registerServerMessageToClientType(final int messageId, final Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt; messageType) {<a name="line.139"></a>
<FONT color="green">140</FONT>                    serverMessageToClientTypeList.put(messageId, messageType);<a name="line.140"></a>
<FONT color="green">141</FONT>            }<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>            /**<a name="line.143"></a>
<FONT color="green">144</FONT>             * Registers a default execution context for a server-to-client message type. Incoming messages of the given type are not queued in<a name="line.144"></a>
<FONT color="green">145</FONT>             * {@link #serverMessages}, but executed directly using the registered execution context. This way the user doesn't have to manually<a name="line.145"></a>
<FONT color="green">146</FONT>             * process these executable client messages.<a name="line.146"></a>
<FONT color="green">147</FONT>             * <a name="line.147"></a>
<FONT color="green">148</FONT>             * @param messageType The type of message that will be matched and executed using the given context object.<a name="line.148"></a>
<FONT color="green">149</FONT>             * @param executionContext The execution context object used to execute executable client messages against.<a name="line.149"></a>
<FONT color="green">150</FONT>             */<a name="line.150"></a>
<FONT color="green">151</FONT>            public void registerExecutionContext(final Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt; messageType, final Object executionContext) {<a name="line.151"></a>
<FONT color="green">152</FONT>                    executionContexts.put(messageType, executionContext);<a name="line.152"></a>
<FONT color="green">153</FONT>            }<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>            /**<a name="line.155"></a>
<FONT color="green">156</FONT>             * Thread safe method that starts the client thread, listening for new messages and sending messages.<a name="line.156"></a>
<FONT color="green">157</FONT>             * <a name="line.157"></a>
<FONT color="green">158</FONT>             * @see InvisibleClientRunner<a name="line.158"></a>
<FONT color="green">159</FONT>             */<a name="line.159"></a>
<FONT color="green">160</FONT>            public void start() {<a name="line.160"></a>
<FONT color="green">161</FONT>                    LOGGER.info(String.format("booting Swift message client (%s). Hold on...", clientType.name()));<a name="line.161"></a>
<FONT color="green">162</FONT>                    stopping = false;<a name="line.162"></a>
<FONT color="green">163</FONT>                    new Thread(new InvisibleClientRunner()).start();<a name="line.163"></a>
<FONT color="green">164</FONT>            }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>            /**<a name="line.166"></a>
<FONT color="green">167</FONT>             * Whether there are unprocessed server messages waiting in queue to be executed.<a name="line.167"></a>
<FONT color="green">168</FONT>             * <a name="line.168"></a>
<FONT color="green">169</FONT>             * @return Whether {@link #serverMessages} contains any entries.<a name="line.169"></a>
<FONT color="green">170</FONT>             */<a name="line.170"></a>
<FONT color="green">171</FONT>            public boolean hasServerResponses() {<a name="line.171"></a>
<FONT color="green">172</FONT>                    return serverMessages.size() &gt; 0;<a name="line.172"></a>
<FONT color="green">173</FONT>            }<a name="line.173"></a>
<FONT color="green">174</FONT>    <a name="line.174"></a>
<FONT color="green">175</FONT>            /**<a name="line.175"></a>
<FONT color="green">176</FONT>             * Returns the queue's next unprocessed server message to be executed.<a name="line.176"></a>
<FONT color="green">177</FONT>             * <a name="line.177"></a>
<FONT color="green">178</FONT>             * @return The first entry of {@link #serverMessages} using {@link LinkedList#poll()}.<a name="line.178"></a>
<FONT color="green">179</FONT>             */<a name="line.179"></a>
<FONT color="green">180</FONT>            public ServerMessageToClient&lt;?&gt; getNextServerResponse() {<a name="line.180"></a>
<FONT color="green">181</FONT>                    return serverMessages.poll();<a name="line.181"></a>
<FONT color="green">182</FONT>            }<a name="line.182"></a>
<FONT color="green">183</FONT>    <a name="line.183"></a>
<FONT color="green">184</FONT>            /**<a name="line.184"></a>
<FONT color="green">185</FONT>             * Thread that assigns {@link #clientEndpoint} with a new client endpoint and starts handling new messages.<a name="line.185"></a>
<FONT color="green">186</FONT>             * &lt;p&gt;<a name="line.186"></a>
<FONT color="green">187</FONT>             * Since {@link Runnable} is a public interface and we don't want the &lt;code&gt;run&lt;/code&gt; method exposed directly, we'll use an<a name="line.187"></a>
<FONT color="green">188</FONT>             * intermediate invisible class (outside the parent class at least) that implements it.<a name="line.188"></a>
<FONT color="green">189</FONT>             * <a name="line.189"></a>
<FONT color="green">190</FONT>             * @author Benny Bottema<a name="line.190"></a>
<FONT color="green">191</FONT>             * @since 1.0<a name="line.191"></a>
<FONT color="green">192</FONT>             */<a name="line.192"></a>
<FONT color="green">193</FONT>            private class InvisibleClientRunner implements Runnable {<a name="line.193"></a>
<FONT color="green">194</FONT>                    @Override<a name="line.194"></a>
<FONT color="green">195</FONT>                    public void run() {<a name="line.195"></a>
<FONT color="green">196</FONT>                            try {<a name="line.196"></a>
<FONT color="green">197</FONT>                                    clientEndpoint = clientType.createClientEndpoint(host, port);<a name="line.197"></a>
<FONT color="green">198</FONT>                                    final String msg = "client booting done. Connection to server established @ port %s (%s)";<a name="line.198"></a>
<FONT color="green">199</FONT>                                    LOGGER.info(String.format(msg, port, clientType.name()));<a name="line.199"></a>
<FONT color="green">200</FONT>                                    handleMessages(clientEndpoint);<a name="line.200"></a>
<FONT color="green">201</FONT>                            } catch (final IOException e) {<a name="line.201"></a>
<FONT color="green">202</FONT>                                    e.printStackTrace();<a name="line.202"></a>
<FONT color="green">203</FONT>                            }<a name="line.203"></a>
<FONT color="green">204</FONT>                    }<a name="line.204"></a>
<FONT color="green">205</FONT>            }<a name="line.205"></a>
<FONT color="green">206</FONT>    <a name="line.206"></a>
<FONT color="green">207</FONT>            /**<a name="line.207"></a>
<FONT color="green">208</FONT>             * Listens for a server to appear on the server endpoint. Creates a new {@link ServerHandler} for the {@link ServerEndpoint}.<a name="line.208"></a>
<FONT color="green">209</FONT>             * <a name="line.209"></a>
<FONT color="green">210</FONT>             * @param clientEndpoint The client endpoint on which we expect server messages.<a name="line.210"></a>
<FONT color="green">211</FONT>             * @throws IOException Thrown by {@link ClientEndpoint#getServerEndpoint()}.<a name="line.211"></a>
<FONT color="green">212</FONT>             */<a name="line.212"></a>
<FONT color="green">213</FONT>            private void handleMessages(final ClientEndpoint clientEndpoint)<a name="line.213"></a>
<FONT color="green">214</FONT>                            throws IOException {<a name="line.214"></a>
<FONT color="green">215</FONT>                    try {<a name="line.215"></a>
<FONT color="green">216</FONT>                            final ServerEndpoint serverEndpoint = clientEndpoint.getServerEndpoint();<a name="line.216"></a>
<FONT color="green">217</FONT>                            if (!isStopping()) {<a name="line.217"></a>
<FONT color="green">218</FONT>                                    final ServerContext serverContext = new ServerContext(serverEndpoint);<a name="line.218"></a>
<FONT color="green">219</FONT>                                    serverHandler = new ServerHandler(this, serverContext);<a name="line.219"></a>
<FONT color="green">220</FONT>                                    new Thread(serverHandler).start();<a name="line.220"></a>
<FONT color="green">221</FONT>                            }<a name="line.221"></a>
<FONT color="green">222</FONT>                    } catch (final SocketException e) {<a name="line.222"></a>
<FONT color="green">223</FONT>                            LOGGER.error("client socket crashed, shutting client down...", e);<a name="line.223"></a>
<FONT color="green">224</FONT>                            stop();<a name="line.224"></a>
<FONT color="green">225</FONT>                    }<a name="line.225"></a>
<FONT color="green">226</FONT>            }<a name="line.226"></a>
<FONT color="green">227</FONT>    <a name="line.227"></a>
<FONT color="green">228</FONT>            /**<a name="line.228"></a>
<FONT color="green">229</FONT>             * Sends the message to using {@link ServerHandler#sendMessage(ClientMessageToServer)}.<a name="line.229"></a>
<FONT color="green">230</FONT>             * <a name="line.230"></a>
<FONT color="green">231</FONT>             * @param message The message to send to the server.<a name="line.231"></a>
<FONT color="green">232</FONT>             */<a name="line.232"></a>
<FONT color="green">233</FONT>            public void sendMessage(final ClientMessageToServer message) {<a name="line.233"></a>
<FONT color="green">234</FONT>                    serverHandler.sendMessage(message);<a name="line.234"></a>
<FONT color="green">235</FONT>            }<a name="line.235"></a>
<FONT color="green">236</FONT>    <a name="line.236"></a>
<FONT color="green">237</FONT>            /**<a name="line.237"></a>
<FONT color="green">238</FONT>             * @return {@link #stopping}<a name="line.238"></a>
<FONT color="green">239</FONT>             */<a name="line.239"></a>
<FONT color="green">240</FONT>            private boolean isStopping() {<a name="line.240"></a>
<FONT color="green">241</FONT>                    return stopping;<a name="line.241"></a>
<FONT color="green">242</FONT>            }<a name="line.242"></a>
<FONT color="green">243</FONT>    <a name="line.243"></a>
<FONT color="green">244</FONT>            /**<a name="line.244"></a>
<FONT color="green">245</FONT>             * Adds a message to the queue for later processing, unless a known context object has been registered for this object in<a name="line.245"></a>
<FONT color="green">246</FONT>             * {@link #executionContexts}.<a name="line.246"></a>
<FONT color="green">247</FONT>             * <a name="line.247"></a>
<FONT color="green">248</FONT>             * @param message The message to be executed now if registered with {@link #executionContexts}, or later manually.<a name="line.248"></a>
<FONT color="green">249</FONT>             */<a name="line.249"></a>
<FONT color="green">250</FONT>            @SuppressWarnings("unchecked")<a name="line.250"></a>
<FONT color="green">251</FONT>            protected void addServerResponse(final ServerMessageToClient&lt;?&gt; message) {<a name="line.251"></a>
<FONT color="green">252</FONT>                    if (executionContexts.containsKey(message.getClass())) {<a name="line.252"></a>
<FONT color="green">253</FONT>                            final Object contextObject = executionContexts.get(message.getClass());<a name="line.253"></a>
<FONT color="green">254</FONT>                            ((ServerMessageToClient&lt;? super Object&gt;) message).execute(contextObject);<a name="line.254"></a>
<FONT color="green">255</FONT>                    } else {<a name="line.255"></a>
<FONT color="green">256</FONT>                            serverMessages.offer(message);<a name="line.256"></a>
<FONT color="green">257</FONT>                    }<a name="line.257"></a>
<FONT color="green">258</FONT>            }<a name="line.258"></a>
<FONT color="green">259</FONT>    <a name="line.259"></a>
<FONT color="green">260</FONT>            /**<a name="line.260"></a>
<FONT color="green">261</FONT>             * @param messageId The message id for which to find the registered message type.<a name="line.261"></a>
<FONT color="green">262</FONT>             * @return The server-to-client message type associated with the given message id, or {@link ServerMessageToClientInvalid} if not found.<a name="line.262"></a>
<FONT color="green">263</FONT>             */<a name="line.263"></a>
<FONT color="green">264</FONT>            protected Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt; getServerMessageToClientType(final int messageId) {<a name="line.264"></a>
<FONT color="green">265</FONT>                    final Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt; messageType = serverMessageToClientTypeList.get(messageId);<a name="line.265"></a>
<FONT color="green">266</FONT>                    return (messageType != null) ? messageType : ServerMessageToClientInvalid.class;<a name="line.266"></a>
<FONT color="green">267</FONT>            }<a name="line.267"></a>
<FONT color="green">268</FONT>    <a name="line.268"></a>
<FONT color="green">269</FONT>            /**<a name="line.269"></a>
<FONT color="green">270</FONT>             * @param clientMessageToServerType The message type to identify.<a name="line.270"></a>
<FONT color="green">271</FONT>             * @return The unique identifier registered for the given message type.<a name="line.271"></a>
<FONT color="green">272</FONT>             */<a name="line.272"></a>
<FONT color="green">273</FONT>            public int getClientMessageId(final Class&lt;? extends ClientMessageToServer&gt; clientMessageToServerType) {<a name="line.273"></a>
<FONT color="green">274</FONT>                    return clientMessageToServerIdList.get(clientMessageToServerType);<a name="line.274"></a>
<FONT color="green">275</FONT>            }<a name="line.275"></a>
<FONT color="green">276</FONT>    <a name="line.276"></a>
<FONT color="green">277</FONT>            /**<a name="line.277"></a>
<FONT color="green">278</FONT>             * Thread safe method to make the client initialize stopping procedure. This means sending a {@link ClientMessageToServerByeBye}, while<a name="line.278"></a>
<FONT color="green">279</FONT>             * closing the client socket simultaneously.<a name="line.279"></a>
<FONT color="green">280</FONT>             */<a name="line.280"></a>
<FONT color="green">281</FONT>            public void stop() {<a name="line.281"></a>
<FONT color="green">282</FONT>                    LOGGER.info("waving server goodbye");<a name="line.282"></a>
<FONT color="green">283</FONT>                    sendMessage(new ClientMessageToServerByeBye());<a name="line.283"></a>
<FONT color="green">284</FONT>                    stopping = true;<a name="line.284"></a>
<FONT color="green">285</FONT>                    shutdown();<a name="line.285"></a>
<FONT color="green">286</FONT>            }<a name="line.286"></a>
<FONT color="green">287</FONT>    <a name="line.287"></a>
<FONT color="green">288</FONT>            private void shutdown() {<a name="line.288"></a>
<FONT color="green">289</FONT>                    try {<a name="line.289"></a>
<FONT color="green">290</FONT>                            clientEndpoint.close();<a name="line.290"></a>
<FONT color="green">291</FONT>                    } catch (final IOException e) {<a name="line.291"></a>
<FONT color="green">292</FONT>                            LOGGER.error(e.getMessage(), e);<a name="line.292"></a>
<FONT color="green">293</FONT>                    }<a name="line.293"></a>
<FONT color="green">294</FONT>            }<a name="line.294"></a>
<FONT color="green">295</FONT>    <a name="line.295"></a>
<FONT color="green">296</FONT>            /**<a name="line.296"></a>
<FONT color="green">297</FONT>             * @return Whether the server is not stopping.<a name="line.297"></a>
<FONT color="green">298</FONT>             */<a name="line.298"></a>
<FONT color="green">299</FONT>            public boolean isRunning() {<a name="line.299"></a>
<FONT color="green">300</FONT>                    return !isStopping();<a name="line.300"></a>
<FONT color="green">301</FONT>            }<a name="line.301"></a>
<FONT color="green">302</FONT>    <a name="line.302"></a>
<FONT color="green">303</FONT>            /**<a name="line.303"></a>
<FONT color="green">304</FONT>             * @return Whether we have an active connection to the server.<a name="line.304"></a>
<FONT color="green">305</FONT>             */<a name="line.305"></a>
<FONT color="green">306</FONT>            public boolean isConnected() {<a name="line.306"></a>
<FONT color="green">307</FONT>                    return serverHandler != null;<a name="line.307"></a>
<FONT color="green">308</FONT>            }<a name="line.308"></a>
<FONT color="green">309</FONT>    <a name="line.309"></a>
<FONT color="green">310</FONT>            /**<a name="line.310"></a>
<FONT color="green">311</FONT>             * Cleans up the server handler in case the connection was dropped.<a name="line.311"></a>
<FONT color="green">312</FONT>             */<a name="line.312"></a>
<FONT color="green">313</FONT>            public void removeServerHandler() {<a name="line.313"></a>
<FONT color="green">314</FONT>                    serverHandler = null;<a name="line.314"></a>
<FONT color="green">315</FONT>            }<a name="line.315"></a>
<FONT color="green">316</FONT>    }<a name="line.316"></a>




























































</PRE>
</BODY>
</HTML>
